// Licensed to Cloudera, Inc. under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  Cloudera, Inc. licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.cloudera.csd.descriptors.parameters;

import com.fasterxml.jackson.annotation.JsonValue;
import com.google.common.base.CaseFormat;

public interface StringParameter extends Parameter<String> {

  /** Regular expression to which this parameter's value should conform. */
  String getConformRegex();

  public enum InitType {
    /**
     * Randomly generated bytes base64 encoded. Length is 30.
     */
    RANDOM_BASE64;

    @JsonValue
    public String toJson() {
      return CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, name());
    }
  }

  /**
   * Type of initialization to set on creation of the owning entity of this
   * parameter. Parameters with initialization are hidden.
   *
   * @return the type
   */
  InitType getInitType();
}
